FileDefinition

The Data Intake Record Definition is used to define the dynamic fields for the Data Intake File and to configure the File's processing instructions.

FileDefinition: Elements and Attributes
Element/Tag Attributes Parent Element Description Element/Attribute Value

<FileDefinition>

 

 

Required element:   

Opening and Closing tag of the file definition.

 

<Fields>

 

<FileDefinition>

Opening and closing tag of the fields configuration. Standard fields configuration applies, although only the <Name>, <Display> and <DataType> sub-elements can be used. See the Fields element page for more information.See Fields Elements

 

<Field>   <Fields>

Repeatable element:

Standard fields configuration applies—see the Fields element page for more information.

 
<Name>   <Field>

Required element:

Standard fields configuration applies—see the Fields element page for more information..

 
<DataType>   <Field>

Required element:

Standard fields configuration applies—see the Fields element page for more information.

DATE

DECIMAL

INTEGER

PERCENT

MONEY

TEXT

<Processing>   <FileDefinition> Opening and closing element of processing configuration.  
<CalculateMissingRecords>   <Processing> Specifies whether the system should compare the current file to a prior data instance—file or system state—to see if records are missing from the current file. Yes: The system will compare the current file.
No: The system will not compare the current file.
<Execution>   <Processing> Opening and closing element of execution configuration.  
<Transaction>   <Execution>

Required, repeatable element:

Defines the file processing transaction. The named transaction must reside within the context of the IntakeProfile (i.e., at the Group Customer or Company level).

The name of a transaction within the context of the IntakeProfile.

XML Schema

<FileDefinition>
<Fields>
<Field>
<Name>FileName</Name>
<Display>DisplayName</Display>
<DataType>EnterDataType</DataType>
<Field>
<Fields>
<Processing>
<CalculateMissingRecords>Yes/NO</CalculateMissingRecords>
<Execution>
<Transaction>IntakeProfileTransaction</Transaction>
</Execution>
</Processing>
</FileDefinition>

XML Example

<FileDefinition>
 <Fields>
 <Field>
<Name>ReceivedRecordCount</Name>
<Display>Received Record Count</Display>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>ExpectedRecordCount</Name>
<Display>Expected Record Count</Display>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>ChangedRecordCount</Name>
<Display>Changed Record Count</Display>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>NoChangeRecordCount</Name>
<Display>No Change Record Count</Display>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>NewToFileRecordCount</Name>
<Display>New To File Record Count</Display>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>RemovedFromFileRecordCount</Name>
<Display>Removed From File Record Count</Display>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>PreProcessBusinessErrorCount</Name>
<Display>PreProcess Business Error Count</Display>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>PreProcessSystemErrorCount</Name>
<Display>PreProcess System Error Count</Display>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>ExecutionBusinessErrorCount</Name>
<Display>Execution Business Error Count</Display>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>ExecutionSystemErrorCount</Name>
<Display>Execution System Error Count</Display>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>RecordWarningCount</Name>
<Display>Record Warning Count</Display>
<DataType>Integer</DataType>
</Field>
<Field>
<Name>AutoCancelCount</Name>
<Display>Auto Cancel Count</Display>
<DataType>Integer</DataType>
</Field>
</Fields>
<Processing>
<CalculateMissingRecords>Yes</CalculateMissingRecords>
<Execution>
<Transaction>IntakeFilePrototype</Transaction>
</Execution>
</Processing>
</FileDefinition>